IImageList.java

/*
 * Copyright (C) 2009 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.yixia.zi.widget.cropimage;

import android.content.ContentResolver;
import android.net.Uri;
import android.os.Parcelable;

import java.io.IOException;
import java.util.HashMap;

//
// ImageList and Image classes have one-to-one correspondence.
// The class hierarchy (* = abstract class):
//
//    IImageList
//    - BaseImageList (*)
//      - VideoList
//      - ImageList
//        - DrmImageList
//      - SingleImageList (contains UriImage)
//    - ImageListUber
//
//    IImage
//    - BaseImage (*)
//      - VideoObject
//      - Image
//        - DrmImage
//    - UriImage
//

/**
 * The interface of all image collections used in gallery.
 */
public interface IImageList extends Parcelable {
	public HashMap<String, String> getBucketIds();

	public void deactivate();

	/**
	 * Returns the count of image objects.
	 * 
	 * @return the number of images
	 */
	public int getCount();

	/**
	 * @return true if the count of image objects is zero.
	 */
	public boolean isEmpty();

	/**
	 * Returns the image at the ith position.
	 * 
	 * @param i the position
	 * @return the image at the ith position
	 */
	public IImage getImageAt(int i);

	/**
	 * Returns the image with a particular Uri.
	 * 
	 * @param uri
	 * @return the image with a particular Uri. null if not found.
	 */
	public IImage getImageForUri(Uri uri);

	/**
	 * 
	 * @param image
	 * @return true if the image was removed.
	 */
	public boolean removeImage(IImage image);

	/**
	 * Removes the image at the ith position.
	 * 
	 * @param i the position
	 */
	public boolean removeImageAt(int i);

	public int getImageIndex(IImage image);

	/**
	 * Generate thumbnail for the image (if it has not been generated.)
	 * 
	 * @param index the position of the image
	 */
	public void checkThumbnail(int index) throws IOException;

	/**
	 * Opens this list for operation.
	 */
	public void open(ContentResolver resolver);

	/**
	 * Closes this list to release resources, no further operation is allowed.
	 */
	public void close();
}